Refresh README, docs, and YouTube integration#1153
Merged
sbryngelson merged 27 commits intoMFlowCode:masterfrom Feb 17, 2026
Merged
Refresh README, docs, and YouTube integration#1153sbryngelson merged 27 commits intoMFlowCode:masterfrom
sbryngelson merged 27 commits intoMFlowCode:masterfrom
Conversation
- Add tagline and hero blockquote (Gordon Bell, 200T grid points, exascale) - Promote shock-droplet image to hero position - Add "Why MFC?" section with 6 key differentiators - Streamline "Try MFC" with direct Codespace link and first-simulation command - Remove redundant Getting Started section (Codespaces detail, macOS from-source) - Deduplicate citation block and star CTA (each appeared twice) - Move star history chart to bottom - Fix 3 broken doc links: md_examples, md_running, md_getting-started Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
…caling plot Add 2025 Gordon Bell Prize Finalist tagline to hero section, OpenGraph and Twitter Card meta tags for link sharing, GitHub stars badge, updated SEO meta description, and replace Frontier+Summit scaling plots with a single three-machine weak scaling figure (El Capitan, Frontier, Alps). Fix LLNL typo and add El Capitan to compute resources footer. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Add alt attributes to all badge <img> tags for accessibility (MD045). Normalize GPU scaling sub-list indentation from mixed tabs/spaces to consistent 4-space indent. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
logo2.png does not exist in docs/res/, causing broken social previews. Use banner.png which is a known-good asset. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Added a link to GitHub assets in the README.
Remove the static shockdrop.png in favor of the embedded shedding water droplet simulation video, which auto-plays and loops on GitHub. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Updated link to the largest known public CFD simulation.
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Replace per-system Frontier SVG with new combined GPU weak scaling PNG covering El Capitan (MI300A), Frontier (MI250X), and Alps (GH200). Mark Summit-era sections as historical. Fix typos. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Use <div> instead of <p> for proper centering of video element. Add controls attribute as fallback when autoplay is blocked. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Update "Is this really exascale?" with combined El Capitan/Frontier/Alps weak scaling plot. Remove Discussions badge since Discussions is disabled. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Generate inverted-grayscale dark variant of weak scaling plot while preserving colored data points. Use <picture> element for automatic light/dark mode switching, matching the star history chart pattern. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
The Doxygen docs site uses a dark theme, so the dark variant of the weak scaling plot matches better. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Fix outdated 'init' subcommand references to 'new' in the Toolchain table and tab completion note. Remove duplicate shock-droplet run command and visualization text already covered in Try MFC section. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Remove stray %09 (encoded tab) from shields.io badge color params - Use light scaling plot in docs (works in both themes) - Fix "LLNL LC" to "LLNL" in docs footer Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Contributor
|
Caution Review failedThe pull request is closed. 📝 WalkthroughWalkthroughDocumentation and UI updates including badge URL fixes, project brief text changes, CSS styling for navigation sidebar, footer simplification, video source migrations from Vimeo to YouTube, navigation grid expansion, and documentation generation header text refinements. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
Suggested labels
Poem
✨ Finishing touches
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #1153 +/- ##
=======================================
Coverage 44.07% 44.07%
=======================================
Files 70 70
Lines 20431 20431
Branches 1974 1974
=======================================
Hits 9004 9004
Misses 10291 10291
Partials 1136 1136 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
1 issue found across 7 files
Confidence score: 4/5
- Minor security hardening opportunity:
docs/index.htmladds a target="_blank" link withoutrel="noopener noreferrer", which could allow window.opener control. - Overall risk is low because the issue is localized to docs and easy to remediate before or after merge.
- Pay close attention to
docs/index.html- addrel="noopener noreferrer"on the new external link.
Prompt for AI agents (all issues)
Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.
<file name="docs/index.html">
<violation number="1" location="docs/index.html:158">
P2: Add rel="noopener noreferrer" on the new target="_blank" link to prevent the opened page from controlling window.opener.</violation>
</file>
Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.
| <i class="pr-4 fa-solid fa-newspaper"></i> | ||
| <span class="flex-1">Papers</span> | ||
| </a> | ||
| <a class="px-4 flex flex-row items-center py-4 border-b-2 hover:border-amber-400" href="https://www.youtube.com/@MFCode" target="_blank"> |
Contributor
There was a problem hiding this comment.
P2: Add rel="noopener noreferrer" on the new target="_blank" link to prevent the opened page from controlling window.opener.
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At docs/index.html, line 158:
<comment>Add rel="noopener noreferrer" on the new target="_blank" link to prevent the opened page from controlling window.opener.</comment>
<file context>
@@ -156,6 +155,10 @@
<i class="pr-4 fa-solid fa-newspaper"></i>
<span class="flex-1">Papers</span>
</a>
+ <a class="px-4 flex flex-row items-center py-4 border-b-2 hover:border-amber-400" href="https://www.youtube.com/@MFCode" target="_blank">
+ <i class="pr-4 fa-brands fa-youtube"></i>
+ <span class="flex-1">YouTube</span>
</file context>
Suggested change
| <a class="px-4 flex flex-row items-center py-4 border-b-2 hover:border-amber-400" href="https://www.youtube.com/@MFCode" target="_blank"> | |
| <a class="px-4 flex flex-row items-center py-4 border-b-2 hover:border-amber-400" href="https://www.youtube.com/@MFCode" target="_blank" rel="noopener noreferrer"> |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR refreshes the project’s public-facing documentation (GitHub README + Doxygen site) and swaps website video links to YouTube, while also tightening up Doxygen page titles and layout.
Changes:
- Shorten Doxygen-generated page titles/headers (“Case Parameters”, “CLI Reference”).
- Update docs landing page: Vimeo → YouTube links, add a YouTube nav item, adjust top-link grid, and tweak sponsor/system wording.
- Doxygen UI tweaks: narrower sidebar, hide nav sync button, and remove the default footer bar.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| toolchain/mfc/params/generators/docs_gen.py | Shortens parameter docs page title and the CLI section header wording. |
| toolchain/mfc/cli/docs_gen.py | Renames the generated CLI reference page title/header to “CLI Reference”. |
| docs/index.html | Replaces video sources with YouTube links; adds YouTube nav link; adjusts layout text/grid. |
| docs/footer.html | Removes the generated footer/navpath output from Doxygen pages. |
| docs/custom.css | Sets a narrower side-nav width and hides the tree sync button. |
| docs/Doxyfile.in | Updates the Doxygen project brief to a shorter tagline. |
| README.md | Fixes badge URL encoding issues and adds a YouTube badge/link. |
| <i class="pr-4 fa-solid fa-newspaper"></i> | ||
| <span class="flex-1">Papers</span> | ||
| </a> | ||
| <a class="px-4 flex flex-row items-center py-4 border-b-2 hover:border-amber-400" href="https://www.youtube.com/@MFCode" target="_blank"> |
There was a problem hiding this comment.
Links that open in a new tab/window should include rel="noopener noreferrer" to prevent reverse-tabnabbing and avoid leaking window.opener. Add the rel attribute alongside target="_blank" here.
Suggested change
| <a class="px-4 flex flex-row items-center py-4 border-b-2 hover:border-amber-400" href="https://www.youtube.com/@MFCode" target="_blank"> | |
| <a class="px-4 flex flex-row items-center py-4 border-b-2 hover:border-amber-400" href="https://www.youtube.com/@MFCode" target="_blank" rel="noopener noreferrer"> |
Comment on lines
+43
to
+45
| <a href="https://www.youtube.com/@MFCode" target="_blank"> | ||
| <img src="https://img.shields.io/badge/YouTube-MFlowCode-red?logo=youtube&style=flat" alt="YouTube"/> | ||
| </a> |
There was a problem hiding this comment.
This new external link uses target="_blank" but is missing rel="noopener noreferrer", which is recommended to prevent reverse-tabnabbing via window.opener. Add the rel attribute for this anchor (and ideally keep it consistent with other target="_blank" links in the README).
3 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
%09from shields.io URLs, fix "LLNL LC" phrasingTest plan
./mfc.sh precheckpasses (all 5 checks)🤖 Generated with Claude Code
Summary by CodeRabbit
Documentation
Style
Chores